<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>DSF2FLAC: cmdline.h File Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">DSF2FLAC
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">cmdline.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The header file for the command line option parser generated by GNU Gengetopt version 2.22.5 <a href="http://www.gnu.org/software/gengetopt">http://www.gnu.org/software/gengetopt</a>.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br/>
</div><table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Where the command line options are stored.  <a href="structgengetopt__args__info.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmdline__parser__params.html">cmdline_parser_params</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The additional parameters to pass to parser functions.  <a href="structcmdline__parser__params.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a3c3df73307452c51fee0a34640d92196">cmdline_parser</a> (int argc, char **argv, struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *args_info)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The command line parser.  <a href="#a3c3df73307452c51fee0a34640d92196"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a78a0cd581698415a62f68214603b1a30">cmdline_parser2</a> (int argc, char **argv, struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *args_info, int override, int initialize, int check_required)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The command line parser (version with additional parameters - deprecated)  <a href="#a78a0cd581698415a62f68214603b1a30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#ac7bb5d76f3f56d1c0b3b531f11ac6f07">cmdline_parser_ext</a> (int argc, char **argv, struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *args_info, struct <a class="el" href="structcmdline__parser__params.html">cmdline_parser_params</a> *params)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The command line parser (version with additional parameters)  <a href="#ac7bb5d76f3f56d1c0b3b531f11ac6f07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a1f73418092a6e6eb3706aa0de2785e11">cmdline_parser_dump</a> (FILE *outfile, struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *args_info)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Save the contents of the option struct into an already open FILE stream.  <a href="#a1f73418092a6e6eb3706aa0de2785e11"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a5f3e9412f88f1058a31ac28ad2ea2818">cmdline_parser_file_save</a> (const char *filename, struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *args_info)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Save the contents of the option struct into a (text) file.  <a href="#a5f3e9412f88f1058a31ac28ad2ea2818"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#ad4f7db2fa4002379eb30e5206f3b7492">cmdline_parser_print_help</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the help.  <a href="#ad4f7db2fa4002379eb30e5206f3b7492"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a96f27bf35ce0ab8eea7a1f6e6b59a5e2">cmdline_parser_print_version</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the version.  <a href="#a96f27bf35ce0ab8eea7a1f6e6b59a5e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#af72b814611cffc706b2135ccdfe7e997">cmdline_parser_params_init</a> (struct <a class="el" href="structcmdline__parser__params.html">cmdline_parser_params</a> *params)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes all the fields a <a class="el" href="structcmdline__parser__params.html" title="The additional parameters to pass to parser functions.">cmdline_parser_params</a> structure to their default values.  <a href="#af72b814611cffc706b2135ccdfe7e997"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcmdline__parser__params.html">cmdline_parser_params</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#afd778af110fe0ee1ea5eac7aa9939d92">cmdline_parser_params_create</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates dynamically a <a class="el" href="structcmdline__parser__params.html" title="The additional parameters to pass to parser functions.">cmdline_parser_params</a> structure and initializes all its fields to their default values.  <a href="#afd778af110fe0ee1ea5eac7aa9939d92"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#aca62b50d03d0d082968eeb1940f98650">cmdline_parser_init</a> (struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *args_info)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the passed <a class="el" href="structgengetopt__args__info.html" title="Where the command line options are stored.">gengetopt_args_info</a> structure's fields (also set default values for options that have a default)  <a href="#aca62b50d03d0d082968eeb1940f98650"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#af1b97c4e92b88f736e350b3902266ba4">cmdline_parser_free</a> (struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *args_info)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Deallocates the string fields of the <a class="el" href="structgengetopt__args__info.html" title="Where the command line options are stored.">gengetopt_args_info</a> structure (but does not deallocate the structure itself)  <a href="#af1b97c4e92b88f736e350b3902266ba4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a83651e5be280d60aed58fdb72456a030">cmdline_parser_required</a> (struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *args_info, const char *prog_name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks that all the required options were specified.  <a href="#a83651e5be280d60aed58fdb72456a030"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a610c3307abce5a8fd304b86b018ae60b">gengetopt_args_info_purpose</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the purpose string of the program  <a href="#a610c3307abce5a8fd304b86b018ae60b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a9f397a306f363bfdebb611e86acf36d5">gengetopt_args_info_usage</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the usage string of the program  <a href="#a9f397a306f363bfdebb611e86acf36d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a6af7a6b7fb37c0abaa916ee1cfa0a41f">gengetopt_args_info_help</a> []</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">all the lines making the help output  <a href="#a6af7a6b7fb37c0abaa916ee1cfa0a41f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#af6e4cf8a2e851ac241127c0d8218f4b0">cmdline_parser_samplerate_values</a> []</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Possible values for samplerate.  <a href="#af6e4cf8a2e851ac241127c0d8218f4b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8h.html#a101ddd33a2cf858c144f9b89b443b5f3">cmdline_parser_bits_values</a> []</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Possible values for bits.  <a href="#a101ddd33a2cf858c144f9b89b443b5f3"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The header file for the command line option parser generated by GNU Gengetopt version 2.22.5 <a href="http://www.gnu.org/software/gengetopt">http://www.gnu.org/software/gengetopt</a>. </p>
<p>DO NOT modify this file, since it can be overwritten </p>
<dl class="author"><dt><b>Author:</b></dt><dd>GNU Gengetopt by Lorenzo Bettini </dd></dl>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a3c3df73307452c51fee0a34640d92196"></a><!-- doxytag: member="cmdline.h::cmdline_parser" ref="a3c3df73307452c51fee0a34640d92196" args="(int argc, char **argv, struct gengetopt_args_info *args_info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="cmdline_8h.html#a3c3df73307452c51fee0a34640d92196">cmdline_parser</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *&#160;</td>
          <td class="paramname"><em>args_info</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The command line parser. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">argc</td><td>the number of command line options </td></tr>
    <tr><td class="paramname">argv</td><td>the command line options </td></tr>
    <tr><td class="paramname">args_info</td><td>the structure where option information will be stored </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if everything went fine, NON 0 if an error took place </dd></dl>

</div>
</div>
<a class="anchor" id="a78a0cd581698415a62f68214603b1a30"></a><!-- doxytag: member="cmdline.h::cmdline_parser2" ref="a78a0cd581698415a62f68214603b1a30" args="(int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="cmdline_8h.html#a78a0cd581698415a62f68214603b1a30">cmdline_parser2</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *&#160;</td>
          <td class="paramname"><em>args_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>override</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>initialize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>check_required</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The command line parser (version with additional parameters - deprecated) </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">argc</td><td>the number of command line options </td></tr>
    <tr><td class="paramname">argv</td><td>the command line options </td></tr>
    <tr><td class="paramname">args_info</td><td>the structure where option information will be stored </td></tr>
    <tr><td class="paramname">override</td><td>whether to override possibly already present options </td></tr>
    <tr><td class="paramname">initialize</td><td>whether to initialize the option structure my_args_info </td></tr>
    <tr><td class="paramname">check_required</td><td>whether to check that all required options were provided </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if everything went fine, NON 0 if an error took place </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>use <a class="el" href="cmdline_8h.html#ac7bb5d76f3f56d1c0b3b531f11ac6f07" title="The command line parser (version with additional parameters)">cmdline_parser_ext()</a> instead </dd></dl>

</div>
</div>
<a class="anchor" id="a1f73418092a6e6eb3706aa0de2785e11"></a><!-- doxytag: member="cmdline.h::cmdline_parser_dump" ref="a1f73418092a6e6eb3706aa0de2785e11" args="(FILE *outfile, struct gengetopt_args_info *args_info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="cmdline_8h.html#a1f73418092a6e6eb3706aa0de2785e11">cmdline_parser_dump</a> </td>
          <td>(</td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>outfile</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *&#160;</td>
          <td class="paramname"><em>args_info</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Save the contents of the option struct into an already open FILE stream. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">outfile</td><td>the stream where to dump options </td></tr>
    <tr><td class="paramname">args_info</td><td>the option struct to dump </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if everything went fine, NON 0 if an error took place </dd></dl>

</div>
</div>
<a class="anchor" id="ac7bb5d76f3f56d1c0b3b531f11ac6f07"></a><!-- doxytag: member="cmdline.h::cmdline_parser_ext" ref="ac7bb5d76f3f56d1c0b3b531f11ac6f07" args="(int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="cmdline_8h.html#ac7bb5d76f3f56d1c0b3b531f11ac6f07">cmdline_parser_ext</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *&#160;</td>
          <td class="paramname"><em>args_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structcmdline__parser__params.html">cmdline_parser_params</a> *&#160;</td>
          <td class="paramname"><em>params</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The command line parser (version with additional parameters) </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">argc</td><td>the number of command line options </td></tr>
    <tr><td class="paramname">argv</td><td>the command line options </td></tr>
    <tr><td class="paramname">args_info</td><td>the structure where option information will be stored </td></tr>
    <tr><td class="paramname">params</td><td>additional parameters for the parser </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if everything went fine, NON 0 if an error took place </dd></dl>

</div>
</div>
<a class="anchor" id="a5f3e9412f88f1058a31ac28ad2ea2818"></a><!-- doxytag: member="cmdline.h::cmdline_parser_file_save" ref="a5f3e9412f88f1058a31ac28ad2ea2818" args="(const char *filename, struct gengetopt_args_info *args_info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="cmdline_8h.html#a5f3e9412f88f1058a31ac28ad2ea2818">cmdline_parser_file_save</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *&#160;</td>
          <td class="paramname"><em>args_info</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Save the contents of the option struct into a (text) file. </p>
<p>This file can be read by the config file parser (if generated by gengetopt) </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>the file where to save </td></tr>
    <tr><td class="paramname">args_info</td><td>the option struct to save </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if everything went fine, NON 0 if an error took place </dd></dl>

</div>
</div>
<a class="anchor" id="af1b97c4e92b88f736e350b3902266ba4"></a><!-- doxytag: member="cmdline.h::cmdline_parser_free" ref="af1b97c4e92b88f736e350b3902266ba4" args="(struct gengetopt_args_info *args_info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="cmdline_8h.html#af1b97c4e92b88f736e350b3902266ba4">cmdline_parser_free</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *&#160;</td>
          <td class="paramname"><em>args_info</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Deallocates the string fields of the <a class="el" href="structgengetopt__args__info.html" title="Where the command line options are stored.">gengetopt_args_info</a> structure (but does not deallocate the structure itself) </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">args_info</td><td>the structure to deallocate </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aca62b50d03d0d082968eeb1940f98650"></a><!-- doxytag: member="cmdline.h::cmdline_parser_init" ref="aca62b50d03d0d082968eeb1940f98650" args="(struct gengetopt_args_info *args_info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="cmdline_8h.html#aca62b50d03d0d082968eeb1940f98650">cmdline_parser_init</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *&#160;</td>
          <td class="paramname"><em>args_info</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes the passed <a class="el" href="structgengetopt__args__info.html" title="Where the command line options are stored.">gengetopt_args_info</a> structure's fields (also set default values for options that have a default) </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">args_info</td><td>the structure to initialize </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="afd778af110fe0ee1ea5eac7aa9939d92"></a><!-- doxytag: member="cmdline.h::cmdline_parser_params_create" ref="afd778af110fe0ee1ea5eac7aa9939d92" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structcmdline__parser__params.html">cmdline_parser_params</a>* <a class="el" href="cmdline_8h.html#afd778af110fe0ee1ea5eac7aa9939d92">cmdline_parser_params_create</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Allocates dynamically a <a class="el" href="structcmdline__parser__params.html" title="The additional parameters to pass to parser functions.">cmdline_parser_params</a> structure and initializes all its fields to their default values. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the created and initialized <a class="el" href="structcmdline__parser__params.html" title="The additional parameters to pass to parser functions.">cmdline_parser_params</a> structure </dd></dl>

</div>
</div>
<a class="anchor" id="af72b814611cffc706b2135ccdfe7e997"></a><!-- doxytag: member="cmdline.h::cmdline_parser_params_init" ref="af72b814611cffc706b2135ccdfe7e997" args="(struct cmdline_parser_params *params)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="cmdline_8h.html#af72b814611cffc706b2135ccdfe7e997">cmdline_parser_params_init</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structcmdline__parser__params.html">cmdline_parser_params</a> *&#160;</td>
          <td class="paramname"><em>params</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes all the fields a <a class="el" href="structcmdline__parser__params.html" title="The additional parameters to pass to parser functions.">cmdline_parser_params</a> structure to their default values. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">params</td><td>the structure to initialize </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ad4f7db2fa4002379eb30e5206f3b7492"></a><!-- doxytag: member="cmdline.h::cmdline_parser_print_help" ref="ad4f7db2fa4002379eb30e5206f3b7492" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="cmdline_8h.html#ad4f7db2fa4002379eb30e5206f3b7492">cmdline_parser_print_help</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Print the help. </p>

</div>
</div>
<a class="anchor" id="a96f27bf35ce0ab8eea7a1f6e6b59a5e2"></a><!-- doxytag: member="cmdline.h::cmdline_parser_print_version" ref="a96f27bf35ce0ab8eea7a1f6e6b59a5e2" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="cmdline_8h.html#a96f27bf35ce0ab8eea7a1f6e6b59a5e2">cmdline_parser_print_version</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Print the version. </p>

</div>
</div>
<a class="anchor" id="a83651e5be280d60aed58fdb72456a030"></a><!-- doxytag: member="cmdline.h::cmdline_parser_required" ref="a83651e5be280d60aed58fdb72456a030" args="(struct gengetopt_args_info *args_info, const char *prog_name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="cmdline_8h.html#a83651e5be280d60aed58fdb72456a030">cmdline_parser_required</a> </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structgengetopt__args__info.html">gengetopt_args_info</a> *&#160;</td>
          <td class="paramname"><em>args_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>prog_name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Checks that all the required options were specified. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">args_info</td><td>the structure to check </td></tr>
    <tr><td class="paramname">prog_name</td><td>the name of the program that will be used to print possible errors </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a101ddd33a2cf858c144f9b89b443b5f3"></a><!-- doxytag: member="cmdline.h::cmdline_parser_bits_values" ref="a101ddd33a2cf858c144f9b89b443b5f3" args="[]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="cmdline_8h.html#a101ddd33a2cf858c144f9b89b443b5f3">cmdline_parser_bits_values</a>[]</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Possible values for bits. </p>

</div>
</div>
<a class="anchor" id="af6e4cf8a2e851ac241127c0d8218f4b0"></a><!-- doxytag: member="cmdline.h::cmdline_parser_samplerate_values" ref="af6e4cf8a2e851ac241127c0d8218f4b0" args="[]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="cmdline_8h.html#af6e4cf8a2e851ac241127c0d8218f4b0">cmdline_parser_samplerate_values</a>[]</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Possible values for samplerate. </p>

</div>
</div>
<a class="anchor" id="a6af7a6b7fb37c0abaa916ee1cfa0a41f"></a><!-- doxytag: member="cmdline.h::gengetopt_args_info_help" ref="a6af7a6b7fb37c0abaa916ee1cfa0a41f" args="[]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="cmdline_8h.html#a6af7a6b7fb37c0abaa916ee1cfa0a41f">gengetopt_args_info_help</a>[]</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>all the lines making the help output </p>

</div>
</div>
<a class="anchor" id="a610c3307abce5a8fd304b86b018ae60b"></a><!-- doxytag: member="cmdline.h::gengetopt_args_info_purpose" ref="a610c3307abce5a8fd304b86b018ae60b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="cmdline_8h.html#a610c3307abce5a8fd304b86b018ae60b">gengetopt_args_info_purpose</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>the purpose string of the program </p>

</div>
</div>
<a class="anchor" id="a9f397a306f363bfdebb611e86acf36d5"></a><!-- doxytag: member="cmdline.h::gengetopt_args_info_usage" ref="a9f397a306f363bfdebb611e86acf36d5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="cmdline_8h.html#a9f397a306f363bfdebb611e86acf36d5">gengetopt_args_info_usage</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>the usage string of the program </p>

</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Sun Oct 13 2013 22:00:19 for DSF2FLAC by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
